Skip to main content

Create a basket

POST 
/baskets

Creates a new basket which you can add products to. You must create a basket before you can call any other API endpoints.

Request​

Header Parameters

    x-api-key stringrequired

    The API key for the given store

Responses​

The newly created empty basket.

Schema
    id stringrequired

    The id of the baske.

    created object
    updated object
    providerBaskets object[]required

    A list of all the providers in the basket. Each provider has their own basket which is aggregated into the overall basket.

  • Array [
    • id object
    expires object
    totalPrice object
    minorUnits int32required
    currencyCode stringrequired
    precision int32required
    lineItems object[]required

    A list of all line items included in the provider basket.

  • Array [
    • id object
    type object

    The type of a line item. OneBasket supports many different product types that can be added to a basket.

    productId object
    totalPrice object
    minorUnits int32required
    currencyCode stringrequired
    precision int32required
    ticketing object

    A ticketing line item represents a product that is related to ticketing.

    type Models.TicketingTyperequired

    Possible values: [TicketedEvent]

    The type of ticketing product this line item represents

    eventType Models.EventType

    Possible values: [SportsMatch]

    If a TicketEvent type, then this indicates what sort of ticketed event.

    sportsMatch object

    If the event type is 'SportsMatch', contains additional information about the line item's event

    matchDate date-timerequired

    The date of the match, including time

    competition objectrequired

    Which competition the match is part of

    name stringrequired

    The name of the competition (Premier League 2021, Champions League 2021, etc)

    season stringrequired

    The season of the competition (2019/20, 2020/21, etc)

    competitionType stringrequired

    The type of competition (Premier League, Champions League, etc)

    hostTeam objectrequired

    The home team

    id stringrequired

    The id of the team

    name stringrequired

    The name of the team

    logoImageUrl string

    The team crest

    opponentTeam objectrequired

    The away team

    id stringrequired

    The id of the team

    name stringrequired

    The name of the team

    logoImageUrl string

    The team crest

    tickets object[]required

    A list of tickets that have been added to the basket for this event.

  • Array [
    • id stringrequired

    The id of the ticket

    providerSeatId stringrequired

    The id of the seat being purchased. This is the id that the provider uses to identify the seat.

    seatCategory stringrequired

    The seat category of the seat being purchased.

    tariff stringrequired

    The tariff of the seat being purchased.

    section stringrequired

    The section the seat is in

    row stringrequired

    The row the seat is in

    seat stringrequired

    The seat number

    price objectrequired

    The price of the ticket, including any taxes.

    minorUnits int32required
    currencyCode stringrequired
    precision int32required
  • ]
    • consumable object

    A consumable line item represents a product that a human can consume (eat or drink).

    quantity int32required

    The number of instances of this product being purchased.

    UnitPrice objectrequired

    The price of a single instance of this product, including any taxes.

    minorUnits int32required
    currencyCode stringrequired
    precision int32required
    productGroupId string

    Optional - The product group that the product belongs to. For consumables, this typically represents a menu.

    kioskId string

    Optional - The kiosk from which this product is being purchased from.

    timestreamId string

    Optional - The time stream that this product is being purchased within. For consumables, this typically represents a time period during an event, such as presales, early bird, half time, etc.

    validUntil date-time

    Optional - The time that this line item is valid until. This represents how long the current price of the line item is valid for. Pricing of products can change if they are in a time stream.

    title stringrequired

    The title of the product. For example, 'Cheeseburger'.

    description string

    The description of the product. For example, 'A delicious cheeseburger with a beef patty, cheese, lettuce, tomato, and onion.'

    allergens string

    The allergens that the product contains. For example, 'Gluten, Dairy, Eggs'.

    image string

    The image of the product.

    calories int32

    The calories of the product.

  • ]
    • deliveryMethods object[]required

    The list of delivery methods available to this provider order, based on what is in the basket. This list can update as you mutate the basket with different products.

  • Array [
    • type stringrequired

    Possible values: [Address, KioskCollection, Email]

    The type of the delivery method

    type stringrequired

    Possible values: [Address]

    options object[]required

    A number of pre created addresses that the customer can select from. If this is empty, then the customer must enter a new address.

  • Array [
    • id stringrequired

    The id of the address

    address stringrequired

    A one line summary of the address

  • ]
  • ]
  • ]
    • customerDetails object[]required

    A list of customer details that are required to be filled in before the basket can be checked out. Note that this list can change as the basket is updated (certain providers may require different details). Also, if you create the basket when not signed in, and then assign the basket to the contact later on, this list will likely require less fields.

  • Array [
    • type object

    The type of a customer detail field.

  • ]
    • totalPrice object
    minorUnits int32required
    currencyCode stringrequired
    precision int32required
Loading...